Skip to content

fix(gha): use app–generated token to create release-please PRs #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2025

Conversation

gberenice
Copy link
Member

@gberenice gberenice commented Jun 16, 2025

what

  • Configure release-please workflow to create PRs using an App–generated token istead of GITHUB_TOKEN.

why

  • When use the repository’s GITHUB_TOKEN to perform tasks on behalf of the GitHub Actions app (the github-actions[bot]), events triggered by that token will not create new workflow runs, with the sole exceptions of workflow_dispatch and repository_dispatch. This is an intentional safeguard to avoid accidental infinite loops of workflows triggering themselves
    github.com.

  • Pull requests created programmatically by the github-actions[bot] (i.e., using GITHUB_TOKEN) do not fire the pull_request event, so any workflow with on: pull_request will not start. Even though the PR appears normally, downstream checks see no trigger and remain stuck, see chore(main): release 0.8.0 #43

references

Summary by CodeRabbit

  • Chores
    • Updated the release workflow to use a GitHub App token for authentication during the release process.

@gberenice gberenice requested a review from a team as a code owner June 16, 2025 16:12
Copy link

coderabbitai bot commented Jun 16, 2025

Walkthrough

A new step has been added to the GitHub Actions workflow for the release-please job to generate a GitHub App token using the tibdex/github-app-token action. This step utilizes the app ID and private key from repository secrets to create the token. The generated token is then explicitly provided to the googleapis/release-please-action step, replacing the previous authentication method and shifting the workflow to use a GitHub App token for authentication.

Suggested reviewers

  • Gowiem
✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch fix/use-pat-instead-of-gh-token
  • Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/release-please.yaml (2)

17-23: Pin and update the GitHub App Token action responsibly
You’ve pinned tibdex/github-app-token to a specific commit which ensures reproducibility—nice! Consider using a stable release tag (e.g., @v3) or periodically updating the SHA to pick up bug fixes and security patches.


26-26: Lock down default GITHUB_TOKEN scopes
Now that you’re supplying an App-generated token for PR operations, you can tighten the workflow’s default permissions (e.g., contents: read and pull-requests: none) to follow least-privilege practices.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 60c58f4 and 3de63d5.

📒 Files selected for processing (1)
  • .github/workflows/release-please.yaml (1 hunks)
🔇 Additional comments (1)
.github/workflows/release-please.yaml (1)

17-23: Verify App installation permissions
Ensure the MP_BOT GitHub App is installed with the correct repository scopes (write access to contents and pull-requests) so the generated token can create and update your release-please PRs.

@Gowiem Gowiem merged commit a0c0d46 into main Jun 16, 2025
5 checks passed
@Gowiem Gowiem deleted the fix/use-pat-instead-of-gh-token branch June 16, 2025 16:56
gberenice pushed a commit that referenced this pull request Jun 17, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.8.0](v0.7.1...v0.8.0)
(2025-06-17)


### Features

* **INT-83:** dial in configs for tflint
([#39](#39))
([60c58f4](60c58f4))


### Bug Fixes

* **gha-trunk-upgrade:** wait for checks and merge with admin
([#42](#42))
([0c399bc](0c399bc))
* **gha:** use app–generated token to create release-please PRs
([#45](#45))
([a0c0d46](a0c0d46))
* linter configs to root folder
([#44](#44))
([7aacf9f](7aacf9f))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: masterpointbot[bot] <177651640+masterpointbot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants